home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 19 / Night Owl (The Best of Shareware)(NOPV 19)(1996).ISO / 007a / traf115.zip / TRAFFIC.DOC < prev    next >
Text File  |  1995-10-14  |  17KB  |  421 lines
  1.  
  2.     Version 1.50, October 14, 1995
  3.  
  4.  
  5.           TTTTT  RRRR     A    FFFFF  FFFFF  II   CCC
  6.             T    R   R   A A   F      F      II  C   C
  7.             T    RRRR   A   A  FFF    FFF    II  C
  8.             T    R   R  AAAAA  F      F      II  C   C
  9.             T    R   R  A   A  F      F      II   CCC
  10.  
  11.  
  12.       RICH VERAA'S LITTLE UNIVERSAL MESSAGEBASE TRAFFIC REPORT
  13.  
  14.                          A BIRDSOFT PROGRAM
  15.  
  16.    (C) Copyright 1991, 1994-5 by Richard P. Veraa. All rights reserved.
  17.        Veraa-Birdsoft Computer Products. North Miami, Florida, USA
  18.  
  19.         TRAFFIC.EXE is a simple messagebase traffic volume report
  20.    generator for use with bulletin board systems using either the
  21.    Fido/Opus, Hudson, JAM, or Squish styles of messagebase.  TRAFFIC
  22.    generates an individual report for each conference area listed in
  23.    an AREAS.BBS-type file (or a restricted list) that you prepare.
  24.    It tabulates each poster to that echo during the report period in
  25.    order of activity, with the number of messages posted, the average
  26.    size of messages by that author, and his/her net address of origin,
  27.    as well as a total number of messages and posters for each area.
  28.    Version 1.05 will now handle up to 1024 posters in up to 1024 conference
  29.    areas.
  30.  
  31.    TRAFFIC.EXE also generates a summary report listing number of
  32.    messages in all chosen areas.
  33.  
  34.    FILES IN THIS ARCHIVE:
  35.  
  36.    README.TRF   - Last minute details.
  37.    TRAFFIC.DOC  - This document.
  38.    AREANAME.RPT - Sample area report produced by TRAFFIC.
  39.    SUMMARY.RPT  - Sample summary report produced by TRAFFIC.
  40.    TRAFFIC.EXE  - TRAFFIC executable file.
  41.    TRSETUP.EXE  - TRAFFIC Configuration program.
  42.    TRPLACE.EXE  - Utility to reset the TRAFFIC lastread pointers.
  43.    REGISTER.TRF - Registration information.
  44.  
  45.  
  46.    GUARANTEE
  47.  
  48.    There is no guarantee, express or implied.  This program works well on
  49.    my system and the systems on which it's been tested... Your mileage,
  50.    as the saying goes, may vary.
  51.  
  52.    USER DEVELOPED SOFTWARE
  53.  
  54.    This program is Shareware.  It is NOT free, and it is NOT public
  55.    domain.  You may try it out for the period of one month.  If you decide
  56.    to continue to use it after that month, you should register your
  57.    copy.  I'm not a professional programmer; I just program for fun.  All
  58.    of what you see is done in my spare time, and the bills are paid out
  59.    of my own pocket.  TRAFFIC will not stop working after one month, or
  60.    do anything nasty, nor does the registered version have more features
  61.    than the non-registered version (except for nicely identifying you
  62.    on the reports it generates).  However, if you don't register
  63.    TRAFFIC, I will not be able to continue to work on it and implement
  64.    new user requested features.  So support shareware!
  65.  
  66.    REGISTRATION
  67.  
  68.    For information on how to register, see the file REGISTER.RPT in
  69.    the TRAFFIC distribution archive.  When I've received your registration
  70.    form and registration fee, I will send you a registration key via
  71.    netmail or snailmail (post).  TRAFFIC will list your name and BBS
  72.    name on the reports it generates to indicate that you're using a
  73.    registered version of TRAFFIC.
  74.  
  75.    For your convenience, you may register TRAFFIC by mail using cash, (not
  76.    recommended, but if you are outside of North America, the difficulties
  77.    involved in other ways of payment may make the risk acceptable), check
  78.    or money order.
  79.  
  80.  
  81.  
  82.  
  83.                              INTRODUCTION
  84.  
  85.    TRAFFIC.EXE works by reading the area tag names from an
  86.    AREAS.BBS-type file called AREAS.TRF that you create, see below.  It
  87.    may include any or all of the areas on your message base.  It then
  88.    searches the messagebase for messages in that area, and looks up each
  89.    poster's net address in the header or origin lines of his/her
  90.    messages.  Finally, it generates detailed reports for each area, and
  91.    a summary report of all listed areas.
  92.  
  93.  
  94.  
  95.  
  96.                              INSTRUCTIONS
  97.  
  98.    Installation
  99.  
  100.    1. Message Base
  101.  
  102.    You must be using a BBS program that utilizes either an Opus (*.MSG),
  103.    Hudson, Squish, or JAM messagebase, or any combination thereof
  104.    and you must have or create an AREAS.BBS (or AREAS.TRF -- see below)
  105.    control file.
  106.  
  107.    2. AREAS.TRF
  108.  
  109.    You will need a file called AREAS.TRF listing the message areas on
  110.    your BBS.  It is similar to AREAS.BBS, and the easiest way to prepare
  111.    AREAS.TRF is to copy AREAS.BBS and deleted unneeded information.  If
  112.    your setup does not use AREAS.BBS, you will need a text file listing
  113.    the areas you wish TRAFFIC to scan.  See Appendix A of this document
  114.    for instructions on constructing one.
  115.  
  116.         Some tossing software (like GEcho) will create an AREAS file for
  117.         you (see 'Export Files' in GSetup if you use GEcho).  If you do
  118.         not want TRAFFIC to count all the areas you carry, -- just make a
  119.         copy of AREAS.BBS named AREAS.TRF.  Delete the lines from AREAS.TRF
  120.         that you do not with reported on.  Delete also the addresses of
  121.         any links that may have been listed in AREAS.BBS (see Appendix A).
  122.  
  123.  
  124.         CAUTION:  AREAS.BBS, as created by many programs lists the
  125.         addresses of links for the areas it lists.  TRAFFIC, on the other
  126.         hand, uses this field for AKA addresses of your system if you use
  127.         different addresses in different areas. (see example in Appendix A)
  128.  
  129.         TRAFFIC will prepare reports for all areas listed in AREAS.TRF.  If
  130.         you do not want TRAFFIC to count all the areas you carry, -- just
  131.         make a copy of AREAS.BBS named AREAS.TRF.  Delete the lines from
  132.         AREAS.TRF that you do not wish reported.  Delete also the addresses
  133.         of any links that may have been listed in AREAS.BBS (see Appendix A).
  134.  
  135.    Most users do not want TRAFFIC to report on ALL the message areas on
  136.    their systems, so when you prepare AREAS.TRF, use an editor to delete
  137.    the lines for the areas you do NOT want reports on.  Note that
  138.    TRAFFIC will start reading at the THIRD line of this file.
  139.  
  140.    3. TRAFFIC.EXE, TRPLACE.EXE and TRSETUP.EXE
  141.  
  142.    Place the above executable files in a convenient directory.  This may
  143.    be the same directory as your mailer or your BBS, depending on how
  144.    your system is set up.  If (as I sincerely hope) you are registered,
  145.    place your key, TRAFFIC.KEY in this directory as well.
  146.  
  147.    4. Configure TRAFFIC by running TRSETUP.
  148.  
  149.    Run TRSETUP from the command line and simply fill in the blanks on
  150.    the screen.  You may use the up and down arrows to change fields until
  151.    all blanks are correct.  Then press <F-10> to accept the displayed
  152.    information.
  153.  
  154.         Enter your name as it appears on your registration form.  If you
  155.         are registered, make this exactly as shown on your key certificate
  156.         -- it is case-sensitive.
  157.  
  158.         Enter your BBS or point name -- or your own name.  This is the name
  159.         that will appear on the reports TRAFFIC generates (if you are a
  160.         registered user).  If you use AKAs other than your principle
  161.         address, list the AKA address after the tagname in AREAS.RPT (see
  162.         Appendix A).  If this field is left blank in AREAS.TRF, TRAFFIC
  163.         will use the default address from TRAFFIC.CFG (Created by
  164.         TRSETUP.EXE) if you are a registered user.
  165.  
  166.         Enter your node or point address (enclosed in parentheses).
  167.  
  168.         Enter the full path designations for the files TRAFFIC needs to
  169.         find:
  170.                      The Hudson messagebase (if used).
  171.                      Data files created by TRAFFIC
  172.                      AREAS.TRF
  173.  
  174.         Enter the path designations for the directories where you wish
  175.         TRAFFIC to place the reports and data files it creates.  These may
  176.         be any valid directory on your system.
  177.  
  178.         Include a trailing backslash "\" after all path names.
  179.  
  180.    5. Operation
  181.  
  182.    Running TRAFFIC.EXE.
  183.  
  184.    Every time TRAFFIC is run, it retrieves its own data and scans the
  185.    message base for new messages in all areas in AREAS.TRF.
  186.  
  187.    TRAFFIC will also generate a summary file called SUMMARY.RPT, listing
  188.    all the areas listed in AREAS.TRF, with the total number of messages
  189.    posted in each, and perform report and reset functions designated by
  190.    command line switches.
  191.  
  192.    6. Command line switches
  193.  
  194.    TRAFFIC may be followed by any or all of the command
  195.    switches (plus none or "/h" for a help screen):
  196.  
  197.        Note: when using more than one switch, leave a space between then,
  198.        and give each its own shash, as:
  199.  
  200.                Ex:   TRAFFIC /n /r /b
  201.  
  202.      /s   SCAN only
  203.  
  204.    TRAFFIC will scan the messagebase, update its data files and lastread
  205.    pointers, but will not produce a report  (unless /r is also switched).
  206.  
  207.      /r   REPORT on individual areas
  208.  
  209.    TRAFFIC will scan the messagebase and generate a separate text file for
  210.    each area, named <tagname>.RPT (tagname truncated at eight characters),
  211.    listing the posters to that area in order of the number of messages
  212.    posted, along with the number of messages posted, and the writer's net
  213.    address, if TRAFFIC can find it on an origin line in the poster's
  214.    message.
  215.  
  216.     /b    Blue screen
  217.  
  218.    The original HTRAFFIC and MTRAFFIC programs were coded with a nice-
  219.    looking blue screen.  It's been suggested that, when running in a batch
  220.    file, it would look more "professional" with a black screen, so this
  221.    minor change was made.  But for those who prefer the old screen, it may
  222.    be invoked with this switch.
  223.  
  224.      /n   NEW data.
  225.  
  226.    Ordinarily TRAFFIC continues to accumulate data so that (assuming
  227.    it's run daily) each days' reports show the current day's mail added
  228.    to the previous day's report.  When the /n switch is used, TRAFFIC
  229.    will write its reports and then discard its old data to start a
  230.    fresh reporting period.  It will also reset its beginning date for
  231.    future report periods.  I run the /n option every two weeks.
  232.    Note: /n AND /z (below) will force TRAFFIC to scan (and report if
  233.    requested) _all_ areas listed in AREAS.TRF, and then reset the pointers
  234.    to begin cumulative reporting from the close of this run.
  235.  
  236.      /z   ZERO place pointers.
  237.  
  238.    This will reset message number pointers prior to scanning.  If you only
  239.    use TRAFFIC periodically, use this switch to scan all messages on your
  240.    system, resetting any old pointers that may remain from previous scans.
  241.  
  242.    6. TRPLACE.EXE
  243.  
  244.    Every time TRAFFIC runs, it creates a four-byte file called
  245.    areaname.NUM for each message area, which keeps track of the
  246.    last message number accounted for by TRAFFIC.  However, if your
  247.    messagebase cleanup utilities renumber the messagebase, this number will
  248.    change.  Accordingly, the little utility TRPLACE.EXE is used to reset
  249.    areaname.NUM to the same number the last message is changed to.  To
  250.    make sure no messages go unreported, it's a good idea to run TRAFFIC
  251.    immediately before cleanup and TRPLACE immediately after, as
  252.    described in the next section.
  253.  
  254.    CAUTION:  Do NOT SORT your messagebase.  Changing the order of messages
  255.    makes it impossible for TRAFFIC to keep track of which ones it has
  256.    counted.
  257.  
  258.    7. Running TRAFFIC from a batch file.
  259.  
  260.    The best way to run TRAFFIC is to call it every night from the batch
  261.    file that runs during your cleanup event.  Call TRAFFIC just before
  262.    cleanup and TRPLACE just after, so that your batch file should look
  263.    something like the following:
  264.  
  265.    CLEAN.BAT
  266.  
  267.               d:\DIRECTORY\TRAFFIC.EXE /r
  268.               d:\DIRECTORY\mbutil purge  (or SQPACK, or whatever)
  269.               d:\DIRECTORY\mbutil pack
  270.               d:\DIRECTORY\mbutil link
  271.               d:\DIRECTORY\TRPLACE.EXE
  272.  
  273.    You'll note that I use the /r (report) option every night.. that way
  274.    I've always got a current report of each echo area in a directory I
  275.    call \FD\STAT\.  Every two weeks, I run TRAFFIC /n /r from the
  276.    command line to make final "official" reports for that period, that
  277.    I can archive for my records.
  278.  
  279.    8.  Occasional use of TRAFFIC
  280.  
  281.    TRAFFIC is designed for daily use to monitor areas over time.  It can
  282.    also be used, however, to make occasional reports of all the messages
  283.    on your messagebase at any time.  In this case, you will want to
  284.    delete old data files created on previous occasions.  Simply delete
  285.    all *.DAT and *.NUM files in TRAFFIC's data file directory.
  286.  
  287.    9. That's all there is to it!
  288.  
  289.    You may register this program for US$ 15.00 and I will send you a key
  290.    that will work on subsequent regular versions.  Registered users of
  291.    our previous traffic programs, MTRAFFIC or HTRAFFIC may register
  292.    TRAFFIC for US$ 5.00.
  293.  
  294.  
  295.                             ACKNOWLEDGEMENTS
  296.  
  297.    Contact me for further information, help, bug reports, comments, or
  298.    Christmas greetings at:
  299.  
  300.            FidoNet 1:135/907
  301.            (You may route crashmail to me via 1:135/0.  All phone lines to
  302.            the building I live in go through a switchoard, making only
  303.            local incoming calls practical).
  304.            Internet rveraa@907.sunshine.com
  305.                     z002798b@bcfreenet.seflin.lib.fl.us
  306.                     rveraa@newssun.med.miami.edu
  307.  
  308.            or by SnailMail at:
  309.  
  310.            Richard Veraa
  311.            Room 211
  312.            Villa Maria Nursing Center
  313.            1050 N.E. 125 Street
  314.            North Miami, FL 33161
  315.  
  316.     Thanks to Ronnie Toth for alpha testing this program, and for
  317.     not giving up on it through the search for some puzzling insects.
  318.  
  319.  
  320.      JAM(mbp) - Copyright 1993 Joaquim Homrighausen, Andrew Milner,
  321.                                Mats Birch, Mats Wallin.
  322.                                ALL RIGHTS RESERVED.
  323.  
  324.      Squish -  Copyright 1990-1994 by SCI Communications.
  325.                    All rights reserved.
  326.                Maximus and Squish are trademarks of SCI Communications.
  327.  
  328.       TRAFFIC was programmed using MkMsgSrc v 1.02
  329.       MKMsgJam - Copyright 1993 by Mark May - MK Software
  330.  
  331.                 Mythical Kingom Tech BBS (513)237-7737 HST/v32
  332.                 FidoNet: 1:110/290
  333.                 Rime: ->MYTHKING
  334.                 maym@dmapub.dma.org
  335.  
  336.                                        Thanks a lot,
  337.  
  338.                                           Cheers,
  339.                                              Rich Veraa
  340.  
  341.    RELATED PROGRAMS:
  342.  
  343.       HTRAFFIC.EXE -- a program similar to TRAFFIC designed for use
  344.       with the popular Hudson messagebase used with RemoteAccess, QuickBBS and
  345.       other boards.  Archived as HTRAFnnn.ARJ.
  346.  
  347.       MTRAFFIC.EXE -- a program similar to TRAFFIC designed for use
  348.       with the Opus-style (*.MSG) messagebase.  Archived as
  349.       MTRAFnnn.ARJ.
  350.  
  351.          The above programs are rendered superfluous by TRAFFIC.EXE.
  352.          Registered users of either may register TRAFFIC.EXE for US$5.00
  353.  
  354.  
  355.                              APPENDIX A.
  356.  
  357.    AREAS.TRF
  358.  
  359.    AREAS.TRF is a plain ASCII text file listing the message areas of
  360.    your BBS that you wish TRAFFIC to process, in the following format:
  361.  
  362.    Line 1: Your BBS Name
  363.  
  364.    Line 2: A semicolon (;)
  365.  
  366.    Remaining lines: The path to message area preceded by:
  367.        '!' for JAM areas;
  368.        '$" for SQUISH areas.
  369.        The area number for HUDSON areas.
  370.        The area pathname for OPUS/*.MSG areas.
  371.  
  372.    If you do not wish to generate traffic reports for all the echoes
  373.    carried by your system, list only the message areas you wish
  374.    TRAFFIC to scan, as described in the installation instructions.
  375.  
  376.    If you use a net address other than your main address for some areas,
  377.    list the AKA after the tagname, and that address will be placed on
  378.    reports for that area (registered users only).
  379.  
  380.    SAMPLE AREAS.TRF FILE
  381.  
  382. Birdsoft Online, North Miami, Florida, USA ! Rich Veraa
  383. ;
  384. ;  Hudson messagebase areas are designated by the AreaNumber on the left
  385. 035  BARDROOM
  386. 077  MUSE
  387. 031  PARROTS
  388. 045  SYSOP_JUNGLE
  389. 043  WRITING
  390. ;
  391. ;  If you use an aKA address in some areas, list the AKA after the
  392. ;  tagname (Registered users only)
  393. 029  UNUSUAL_PETS       50:305/907
  394. ;
  395. ; Opus/Fido *.MSG areas have the pathname with no prefix on the left
  396. D:\FD\PKDROP\                  PKEY_DROP
  397. D:\FD\Z1E\                     Z1_ELECTION
  398. ;
  399. ;  Note optional AKA in following Opus/Fido listing
  400. D:\FD\FLOO                     FL_OOZ              129:131/907
  401. ;
  402. ; JAM message areas are indicated by an exclamation point "!" on the
  403. ; left
  404. !E:\JAM\A1\EXOTIC_B            EXOTIC_BIRDS
  405. !E:\JAM\A1\ALTMED              ALTMED
  406. !E:\JAM\A1\AVICULTU            AVICULTURE
  407. ;
  408. ;  Note optional AKA in following JAM listing:
  409. !E:\JAM\A1\FL_LIVIN            FL_LIVING          129:131/907
  410. ;
  411. ;  Indicate Squish areas with an "$"
  412. $D:\SQUISH\MSG\NETSYSOP      NETSYSOP
  413. $D:\SQUISH\MSG\PASCAL_L      PASCAL_LESSONS
  414. ;  Note optional AKA in following Squish listing:
  415. $D:\SQUISH\MSG\NET_CHAT      OTHERNET_CHAT         50:305/907
  416. ;
  417.  
  418.  
  419.                                -END-
  420.  
  421.